/*
 * Copyright 2018 JDCLOUD.COM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http:#www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Snapshot Template
 * 截图模板相关接口
 *
 * OpenAPI spec version: v1
 * Contact: 
 *
 * NOTE: This class is auto generated by the jdcloud code generator program.
 */


using System;
using System.Collections.Generic;
using System.Text;
using JDCloudSDK.Core.Service;

using JDCloudSDK.Mps.Model;
using JDCloudSDK.Core.Annotation;

namespace  JDCloudSDK.Mps.Apis
{

    /// <summary>
    ///  创建截图模板
    /// </summary>
    public class CreateSnapshotTemplateRequest : JdcloudRequest
    {
        ///<summary>
        /// 模板标题。长度不超过 128 个字节。UTF-8 编码。
        ///Required:true
        ///</summary>
        [Required]
        public   string Title{ get; set; }
        ///<summary>
        /// 截图起始时间，取值范围单位为秒，缺省值为 0
        /// 
        ///</summary>
        public   int? StartTime{ get; set; }
        ///<summary>
        /// 截图帧类型。取值范围：
        ///   any - 任意帧
        ///   intra - 关键帧
        /// 缺省值为 any
        /// 
        ///</summary>
        public   string FrameType{ get; set; }
        ///<summary>
        /// 截图格式。取值范围：
        ///   jpg - 对应的截图或雪碧图输出文件扩展名为 jpg
        ///   png - 对应的截图或雪碧图输出文件扩展名为 png
        /// 缺省值为 jpg
        /// 
        ///</summary>
        public   string Format{ get; set; }
        ///<summary>
        /// 截图数量。取值范围：[1, 3600]
        /// 缺省值为 10
        /// 若雪碧图配置不为空，则生成雪碧图，提交的截图任务中，此字段会被雪碧图的行列积所覆盖。
        /// 
        ///</summary>
        public   int? Number{ get; set; }
        ///<summary>
        /// 截图时间间隔。取值范围：[1, 100]，单位为秒
        /// 若未设置，则对于普通截图，按照截图张数做平均截图；对于雪碧图，则按照行列数乘积做平均截图
        /// 
        ///</summary>
        public   int? Interval{ get; set; }
        ///<summary>
        /// 截图宽度，取值范围：[8, 4096]
        /// 若宽度和高度同时设置，则按照设置的宽高截图；
        /// 若宽度和高度均未设置，则截图保持与源视频相同的宽高值；
        /// 若宽度和高度其中一项未设置，则截图保持与源视频相同的宽高比；
        /// 
        ///</summary>
        public   int? Width{ get; set; }
        ///<summary>
        /// 截图高度，取值范围：[8, 4096]
        /// 若宽度和高度同时设置，则按照设置的宽高截图；
        /// 若宽度和高度均未设置，则截图保持与源视频相同的宽高值；
        /// 若宽度和高度其中一项未设置，则截图保持与源视频相同的宽高比；
        /// 
        ///</summary>
        public   int? Height{ get; set; }
        ///<summary>
        /// 填充方式，当视频宽高与截图宽高指定值不能匹配时的填充处理方式。取值范围：
        ///   stretch - 伸缩
        ///   black - 留黑
        ///   white - 留白
        ///   gauss - 高斯模糊
        /// 缺省值为 black
        /// 
        ///</summary>
        public   string FillType{ get; set; }
        ///<summary>
        /// 雪碧图配置。若此字段有值，则生成雪碧图。
        /// 
        ///</summary>
        public   SpriteConfig SpriteConfig{ get; set; }
    }
}